<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.appgroups.html">appgroups</a> . <a href="apigee_v1.organizations.appgroups.apps.html">apps</a> . <a href="apigee_v1.organizations.appgroups.apps.keys.html">keys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="apigee_v1.organizations.appgroups.apps.keys.apiproducts.html">apiproducts()</a></code>
</p>
<p class="firstline">Returns the apiproducts Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.</p>
<p class="toc_element">
  <code><a href="#updateAppGroupAppKey">updateAppGroupAppKey(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.

Args:
  parent: string, Required. Parent of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys` (required)
  body: object, The request body.
    The object takes the form of:

{ # AppGroupAppKey contains all the information associated with the credentials.
  &quot;apiProducts&quot;: [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    { # APIProductAssociation has the API product and its administrative state association.
      &quot;apiproduct&quot;: &quot;A String&quot;, # API product to be associated with the credential.
      &quot;status&quot;: &quot;A String&quot;, # The API product credential associated status. Valid values are `approved` or `revoked`.
    },
  ],
  &quot;attributes&quot;: [ # List of attributes associated with the credential.
    { # Key-value pair to store extra metadata.
      &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
      &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
    },
  ],
  &quot;consumerKey&quot;: &quot;A String&quot;, # Immutable. Consumer key.
  &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
  &quot;expiresAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app expires in milliseconds since epoch.
  &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can&#x27;t be updated after it is set.
  &quot;issuedAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app was created in milliseconds since epoch.
  &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
    &quot;A String&quot;,
  ],
  &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroupAppKey contains all the information associated with the credentials.
  &quot;apiProducts&quot;: [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    { # APIProductAssociation has the API product and its administrative state association.
      &quot;apiproduct&quot;: &quot;A String&quot;, # API product to be associated with the credential.
      &quot;status&quot;: &quot;A String&quot;, # The API product credential associated status. Valid values are `approved` or `revoked`.
    },
  ],
  &quot;attributes&quot;: [ # List of attributes associated with the credential.
    { # Key-value pair to store extra metadata.
      &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
      &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
    },
  ],
  &quot;consumerKey&quot;: &quot;A String&quot;, # Immutable. Consumer key.
  &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
  &quot;expiresAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app expires in milliseconds since epoch.
  &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can&#x27;t be updated after it is set.
  &quot;issuedAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app was created in milliseconds since epoch.
  &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
    &quot;A String&quot;,
  ],
  &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes an app&#x27;s consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.

Args:
  name: string, Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroupAppKey contains all the information associated with the credentials.
  &quot;apiProducts&quot;: [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    { # APIProductAssociation has the API product and its administrative state association.
      &quot;apiproduct&quot;: &quot;A String&quot;, # API product to be associated with the credential.
      &quot;status&quot;: &quot;A String&quot;, # The API product credential associated status. Valid values are `approved` or `revoked`.
    },
  ],
  &quot;attributes&quot;: [ # List of attributes associated with the credential.
    { # Key-value pair to store extra metadata.
      &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
      &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
    },
  ],
  &quot;consumerKey&quot;: &quot;A String&quot;, # Immutable. Consumer key.
  &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
  &quot;expiresAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app expires in milliseconds since epoch.
  &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can&#x27;t be updated after it is set.
  &quot;issuedAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app was created in milliseconds since epoch.
  &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
    &quot;A String&quot;,
  ],
  &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.

Args:
  name: string, Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroupAppKey contains all the information associated with the credentials.
  &quot;apiProducts&quot;: [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    { # APIProductAssociation has the API product and its administrative state association.
      &quot;apiproduct&quot;: &quot;A String&quot;, # API product to be associated with the credential.
      &quot;status&quot;: &quot;A String&quot;, # The API product credential associated status. Valid values are `approved` or `revoked`.
    },
  ],
  &quot;attributes&quot;: [ # List of attributes associated with the credential.
    { # Key-value pair to store extra metadata.
      &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
      &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
    },
  ],
  &quot;consumerKey&quot;: &quot;A String&quot;, # Immutable. Consumer key.
  &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
  &quot;expiresAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app expires in milliseconds since epoch.
  &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can&#x27;t be updated after it is set.
  &quot;issuedAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app was created in milliseconds since epoch.
  &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
    &quot;A String&quot;,
  ],
  &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>

<div class="method">
    <code class="details" id="updateAppGroupAppKey">updateAppGroupAppKey(name, body=None, x__xgafv=None)</code>
  <pre>Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

Args:
  name: string, Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for UpdateAppGroupAppKey
  &quot;action&quot;: &quot;A String&quot;, # Approve or revoke the consumer key by setting this value to `approve` or `revoke` respectively. The `Content-Type` header, if set, must be set to `application/octet-stream`, with empty body.
  &quot;apiProducts&quot;: [ # The list of API products that will be associated with the credential. This list will be appended to the existing list of associated API Products for this App Key. Duplicates will be ignored.
    &quot;A String&quot;,
  ],
  &quot;appGroupAppKey&quot;: { # AppGroupAppKey contains all the information associated with the credentials. # Note that only Scopes and Attributes of the AppGroupAppKey can be amended. Scopes and Attributes mentioned in the request will be inserted and the existing scopes and attributes will be removed.
    &quot;apiProducts&quot;: [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
      { # APIProductAssociation has the API product and its administrative state association.
        &quot;apiproduct&quot;: &quot;A String&quot;, # API product to be associated with the credential.
        &quot;status&quot;: &quot;A String&quot;, # The API product credential associated status. Valid values are `approved` or `revoked`.
      },
    ],
    &quot;attributes&quot;: [ # List of attributes associated with the credential.
      { # Key-value pair to store extra metadata.
        &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
        &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
      },
    ],
    &quot;consumerKey&quot;: &quot;A String&quot;, # Immutable. Consumer key.
    &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
    &quot;expiresAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app expires in milliseconds since epoch.
    &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can&#x27;t be updated after it is set.
    &quot;issuedAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app was created in milliseconds since epoch.
    &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
      &quot;A String&quot;,
    ],
    &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroupAppKey contains all the information associated with the credentials.
  &quot;apiProducts&quot;: [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    { # APIProductAssociation has the API product and its administrative state association.
      &quot;apiproduct&quot;: &quot;A String&quot;, # API product to be associated with the credential.
      &quot;status&quot;: &quot;A String&quot;, # The API product credential associated status. Valid values are `approved` or `revoked`.
    },
  ],
  &quot;attributes&quot;: [ # List of attributes associated with the credential.
    { # Key-value pair to store extra metadata.
      &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
      &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
    },
  ],
  &quot;consumerKey&quot;: &quot;A String&quot;, # Immutable. Consumer key.
  &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
  &quot;expiresAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app expires in milliseconds since epoch.
  &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can&#x27;t be updated after it is set.
  &quot;issuedAt&quot;: &quot;A String&quot;, # Output only. Time the AppGroup app was created in milliseconds since epoch.
  &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
    &quot;A String&quot;,
  ],
  &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>

</body></html>